home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Night Owl 6
/
Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso
/
049a
/
womr_120.zip
/
WOMR.DOC
< prev
next >
Wrap
Text File
|
1991-07-09
|
26KB
|
990 lines
█ █ ▄▀▀▄ ▄▀▄▀▄ █▀▀▄
█ █ █ █ █ █ █ █ █▀▀▄
▀ ▀ ▀▀ ▀ ▀ ▀ ▀
WWIV Off-line Message Reader v1.20
Sysop's Manual
Copyright (C) 1990, 1991 by Will Hobday
All Rights Reserved
WWIV Off-line Message Reader v1.20 Sysop's Manual
Table of Contents
-----------------------------------------------------------------
1. Introduction ............................................. 1
Features ............................................... 1
Licensing .............................................. 1
Customer Support ....................................... 2
2. Installation and Setup ................................... 4
Installation ........................................... 4
Setup .................................................. 4
3. The WOMR BBS Module ...................................... 6
Usage .................................................. 6
Messages ............................................... 6
Error Messages ......................................... 6
Status Messages ........................................ 7
4. The User Status Screen ................................... 8
Screen Access .......................................... 8
User Status ............................................ 8
Scan Status ............................................ 8
User Screen ............................................ 8
Appendices
A. Problems, Precautions and USER.LST ...................... 9
B. Log File Format ......................................... 11
C. Revision History ........................................ 12
WWIV Off-line Message Reader v1.20 Sysop's Manual
1 - Introduction
-----------------------------------------------------------------
FEATURES
WOMR is an off-line message reader for the WWIV BBS system. It
will allow a user to call up and fetch any unread messages he/she
has waiting. It ultimately will allow a user to send 'reply'
packets and thus be an actual extension of your BBS to the users
system. Not only will it allow your users more time on-line, but
it will also free up the board for more users. The best of both
worlds! Among its current capabilities are:
o The fastest off-line reader available for WWIV
o Captures all unread messages and e-mail
o Easy to use "Windowed" environment
o Built in setup program and configuration file for a
minimum of clutter
o Hardware Independent - works with virtually any machine
o Support for any serial port configuration. Port
addresses and IRQ's are configurable
o UART(serial port) speeds up to 115,200bps.
o Full support for the NS16550A/AF/AFN UART chip.
o User Aware - Monitors carrier detect and time-out
o Sysop friendly - Can be run locally and/or without
updating the user list
o Optional logging of all transactions
o runs independent of connect speed
o ANSI support for remote users
o Compatible with all WWIV BBSs - even nonstandard
configurations. Modifiers rejoice!
Coming soon.....
o The ability to receive and decode reply packets for
true off-line capability
o Remote file request and "off-line uploading".
o Remote user configuration
o Configurable transfer protocols
o and much more!!
LICENSING
WOMR is the generic term for the BBS Module. WOMREAD is the
generic term for the Off-line Module. Both modules comprise the
"WOMR system package".
Page - 1
WWIV Off-line Message Reader v1.20 Sysop's Manual
WOMR and its related programs are NOT public domain or freeware!
The WOMR system package is a copyrighted software product
developed and owned by Will Hobday and Dave Herndon.
WOMR is distributed as shareware. As such, sysops may evaluate
the WOMR BBS module for a maximum period of 30 days. At the end
of the evaluation period, if you find WOMR to be a useful tool and
wish to continue using it, you must register your copy.
Information on becoming a registered user can be found in the file
ORDERFRM.
The WOMR BBS Module is licensed "AS IS". Will Hobday does not
make any warranty, whether oral or written, expressed or implied,
with any respect to the quality, performance, merchantability or
fitness for any particular purpose, and no other representation of
claims of any nature shall be binding on or obligate William
Hobday. By using WOMR, you agree that neither William Hobday nor
any officers, directors, employees, shareholders, affiliates,
owners, or other related parties will be liable for special,
incidental or consequential damage resulting from possession, use
or malfunction of this product, including damage to property and
to the extent permitted by law, damages for personal injury, even
if the author, William Hobday, is notified of such possibility in
advance.
This agreement shall be governed by the laws of the state of
Maryland.
CUSTOMER SUPPORT
We WANT your suggestions!!! This is a product for ALL WWIV users,
not just us. We will remain open to ALL feedback. Remember, We
can only incorporate your ideas if you tell us.
If you have a question or a problem with WOMR we will always be
more than happy to help. If you follow these simply steps your
problem will be solved in no time:
o Read the documentation thoroughly. Many times problems
can be resolved by finding the answer in the manual.
o Duplicate the problem one your system more than once.
Lets just make sure it wasn't a freak occurrence.
o If you are still having problems, support is available!
■ Subscribe to the WOMR support sub on the WWIV.
Contact Darkster/Dave at 1@3114 for more info.
■ Call the WOMR support BBS
Page - 2
WWIV Off-line Message Reader v1.20 Sysop's Manual
The Dark Side of the Moon runs 24hrs a day at
(301)666-9109. We support v.32/42bis/HST via a USR
Dual Standard modem. A special account has been set
up for WOMR support. Log on to account #4, the
password is "WOMR". From here you will have access
to the WOMR Support Forum , as well as the latest
version of WOMR.
■ Leave E-Mail
WWIV: 2@3114
FIDO: 1:261/1090 to Will Hobday
RIME: ECLIPSE->WILL HOBDAY
■ Drop a note via US Mail
Will Hobday
14204 Pioneer Circle
Glenelg, MD 21737
Page - 3
WWIV Off-line Message Reader v1.20 Sysop's Manual
2 - Setup and Installation
------------------------------------------------------------------
INSTALLATION
A few simple guidelines must be followed to install WOMR on your
system.
o Copy WOMR.EXE to your WWIV directory.
o Verify DSZ.COM and PKZIP.EXE are in your current path.
o Add WOMR to your list of chains with Chainedit with the
following options:
■ Filename = "WOMR %1"
■ Do not intercept DOS calls
■ Shrink out
o Create opening messages for users. WOMR.ANS for ansi
users and WOMR.MSG for non-ansi. Place them in your
GFILES directory. If WOMR is unable to locate an opening
message it will simply continue.
SETUP
WOMR was designed with simplicity in mind! Every effort has been
made to make it as simple to install as possible.
Execute WOMR.EXE without parameters to invoke the setup program.
You will see a couple of options that must be set before WOMR will
run correctly on your system.
The options that must be set are:
o BBS Packet ID - Up to four letters that will identify
your BBS packet to the user. For example here at the Dark
Side of the Moon our id is 'DSM'.
o Time-out value - The amount of time, in seconds, that a
user has to respond to an on-line prompt.
o Update User Record - This is VERY important!!! This
option controls whether or not WOMR will update q-scan
pointers. If it is set to 'NO' it WILL NOT update the
pointers. If it is set to 'YES' it WILL update the
pointers. Make sure WOMR is working properly on your
Page - 4
WWIV Off-line Message Reader v1.20 Sysop's Manual
system before you enable this option!!!!!
o Enable Log - YES will cause WOMR to keep a monthly log in
your GFILES directory. NO disables it.
o 64 Sub Mod Installed - If you have the 64 sub mod
installed set this option to 'YES', otherwise leave it
alone! Be careful with this one. WOMR may seem to work
correctly even if this option isn't set properly. Be on
the look out for incorrect number of messages.
Test WOMR thoroughly after setup is complete. If WOMR isn't
scanning the correct messages please refer to appendix A.
Page - 5
WWIV Off-line Message Reader v1.20 Sysop's Manual
3 - The WOMR BBS Module
------------------------------------------------------------------
USAGE
In order for WOMR to work, it must be given the correct command
line. Anything appearing in brackets is not literal.
o WOMR <no options> - invokes WOMR's internal setup program
o WOMR [path to chain.txt] - process the user in chain.txt
o WOMR /DUMP - display WOMR's internal variable offsets.
MESSAGES
WOMR conveys a number of messages to the sysop. They will fall
into one of two categories: Error Messages or Status Messages.
An Error message will be displayed when WOMR encounters a
situation that halts processing. Status messages are displayed on
the user status screen and keep the SYSOP informed of what WOMR is
doing.
ERROR MESSAGES
PKZIP | Not found in path
WOMR couldn't find PKZIP in the path
DSZ | Not found in path
WOMR couldn't find DSZ in the path
PKZIP Failure | Exit Code xxx
PKZIP exited unsuccessfully with Exit Code xxx
DSZ Failure | Exit Code xxx
DSZ exited unsuccessfully with Exit Code xxx
Invalid path to CHAIN.TXT
The path given to WOMR was invalid for CHAIN.TXT
Not enough memory
Out of memory, did you shrink out?
No such file or directory
WOMR can't find the file its looking for
Page - 6
WWIV Off-line Message Reader v1.20 Sysop's Manual
Too many open files
There are too many open files. Try increasing FILES in
your config.sys
Permission Denied
WOMR tried to write or create a file that it doesn't have
access to
STATUS MESSAGES
Sending Shareware Message
WOMR is currently sending the shareware message. NOTE: This
will not appear on registered versions.
Shareware Pause
WOMR is pausing to allow the reader to read the shareware
notice. Once again this will not appear to registered users.
Sending XXXX/XXXX
WOMR is currently displaying the file XXXX/XXXX to the user.
Opening Files
WOMR is creating and opening the necessary files
Writing System Data
Your system data is being written to the womr support files
Closing Files
Files are being closed and WOMR is preparing to compress the
packet.
Updating Q-Scan Pointers
WOMR is updating the users Q-Scan pointers
Waiting for Reply
WOMR is waiting for the user to reply to a prompt. Time-out
is in effect.
Scanning E-Mail
WOMR is currently scanning for users E-Mail
Scanning
WOMR is scanning each sub for unread messages
Aborted Scan!
WOMR was unable to find one of the supporting files for the
current sub.
Page - 7
WWIV Off-line Message Reader v1.20 Sysop's Manual
4 - The User Status Screen
------------------------------------------------------------------
SCREEN ACCESS
WOMR has built in support for the DESQview/Windows/TopView
interfaces. EGA 43 and VGA 50-line modes are fully supported as
well as non-standard video configurations(132x25, 120x43, etc.)
WOMR will work with any system configuration, whether it be color
or monochrome.
STATUS SCREEN
The status screen is divided into three different sections. User
Status, Scan Status, and User Screen. Each serves a specific
purpose and conveys much information.
USER STATUS
The user status window contains all the pertinent information
about the user. In no specific order they are: Alias, Real Name,
User number, SL, AR, ANSI enabled, and Remote status.
SCAN STATUS
The majority of activity will be displayed in the scan status
window. The current subs information is displayed as well as a
graphic progress bar. The message line is located at the bottom
of the window. Here WOMR relays any pertinent information to the
sysop.
USER SCREEN
This is what the user is seeing. A SYSOP can assist novice users
by helping them answer prompts from his keyboard or monitor any
"suspicious" users.
Page - 8
WWIV Off-line Message Reader v1.20 Sysop's Manual
Appendix A - Problems, Precautions and USER.LST
------------------------------------------------------------------
█ █ ▄▀▀▄ █▀▀▄ █▄ █ █ █▄ █ ▄▀▀
█ █ █ █▀▀█ █▀▀▄ █ ▀█ █ █ ▀█ █ ▀▄
▀ ▀ ▀ ▀ ▀ ▀ ▀ ▀ ▀ ▀ ▀ ▀▀
Just a reminder! As you well know this program will modify your
USER.LST. I recommend backing up your USER.LST before running
WOMR for the first time.
Test WOMR THOROUGHLY before you enable 'Update User Record'! Make
sure WOMR is scanning all subs as it should and extracting all the
correct messages.
WOMR will work with many different systems in its default
configuration even if mods are installed. WOMR relies on several
conditions to read the USER.LST correctly.
In CONFIG.DAT are stored the following:
o Size of userrec
o offset of inact in userrec
o offset of waiting in userrec
These are crucial and must be correct before WOMR is configured
for the first time. You can verify them by running DISPLAY.C
which I've included. In addition to this the userrec must be in
a somewhat standard order. WOMR reads the following variables
from USER.LST:
o name[31]
o realname[21]
o age
o sex
o inact
o sl
o waiting
o ar
o qscn and qscn2 if applicable
o qscnptr[33] or qscnptr[65]
WOMR calculates the offset as follows:
o name[31] and realname[21] must be the first and second
variables
o sex must be at offset inact - 2
o age must be at offset inact - 1
o the offset of sl must be equal to inact + 6
Page - 9
WWIV Off-line Message Reader v1.20 Sysop's Manual
o the offset of ar must be equal to waiting + 21
o the offset of qscn must be equal to waiting + 49
WOMR will only work correctly in its default configuration if
these conditions are met!!! To put it in more general terms: If
you have any mods installed, no variables should be inserted
between sex and qscn!
If you VARDEC.H doesn't meet these guidelines or WOMR isn't
working correctly on your system, I recommend using WOMRSET.
WOMRSET will assure that WOMR is configured correctly by using
your VARDEC.H to configure its offsets. See the accompanying
documentation for more info on WOMRSET.
Page - 10
WWIV Off-line Message Reader v1.20 Sysop's Manual
Appendix B - Log File Format
------------------------------------------------------------------
The log file consists of a entry for each time WOMR is activated
in scan mode. For example:
START | 06/01/1991 | 21:12:15.56
Processing WILL #1 - 2400N81
Messages: 21 Email: 1
Elapsed time 00:05.54
The first line records the time and date the scan was started.
The second denotes the user being scanned and the current com port
status. The third logs the number of messages and email scanned
and finally the last line is the elapsed time. All critical
errors are logged.
Page - 11
WWIV Off-line Message Reader v1.20 Sysop's Manual
Appendix C - Revision History
------------------------------------------------------------------
0.95 - First public Beta Release
0.95a - Added logging feature
- Fixed WOMR so it wouldn't abort when it couldn't
find XXXX.DAT or XXX.SUB for an area
- Fixed configuration when entering PacketID. A response is
now required and it will be all caps
- various minor changes
0.95b - added 16550 support
- added support for any com port configurations
- Redesigned remote user screens
- add configurable time-out value
- WOMR now detects if user has hung up during N-scan
- added elapsed time to log + extended other logging
- scans for new email
- improved sysop status screen
0.95c - added ANSI support for remote users
- minimized calls to write for better performance
- rewrote q-scan algorithm for increased reliability and
speed
- wrote WOMRSET.C to set WOMR's internal offsets for any
vardec.h
- added check for age when determining which subs to
scan(an oversite on my part)
- wrote algorithm to optimize message headers for
maximal compression
- ditto system data
- rewrote various other functions to improve speed
and size
- recompiled WOMR with BC++
0.98 - Standardized version numbers. WOMR now conforms with
WOMREAD.
- added /DUMP to display WOMR's internal offsets
- Fixed bug that wouldn't allow WOMR to run unless using DOS
3.3 or greater
- Fixed possible bug in comm routines. It wasn't
monitoring carrier when flushing internal buffer
- Expanded the number of internal offsets WOMR keeps
track of for compatibility with more systems
1.00 - reworked some of the com routines
- added shareware notice
- fixed error introduced in 0.98 that added subs even if
there were no messages in it
- not so numerous other minor fixes
Page - 12
WWIV Off-line Message Reader v1.20 Sysop's Manual
1.10 - added flow control for high speed modems and locked com
ports
- added user option to abort scan in progress
- added sysop option to abort scan in progress
- totally restructured source code
- cleaned up exit procedures
- WOMR now adapts to any screen size
- fixed bug where WOMR wasn't reading the bit mapped message
status correctly
- fixed bug where WOMR was scanning ANSI subs when user was
non-ansi
1.11 - WOMR wasn't passing the correct command line to DSZ after
I played with the compiler switches
- WOMR was writing incorrect offsets to the index file
- WOMR wasn't correctly updating the Q-Scan pointers on
certain subs
1.12 - fixed small bug when WOMR scanned subs with one message
left in them
1.20 - added internal buffering routines
- added packet number configuration option
- WOMR now shows version number in setup screen
- significantly changed user status screen
- fixed minor bug, WOMR on occasion wouldn't display the
opening message
- sysop can now enter responses for users at prompts
- rewrote documentation.
Page - 13